StartNew Method (Func(Object, TResult), Object, CancellationToken, TaskCreationOptions, TaskScheduler)

Task Parallel System.Threading

previous page next page

Creates and starts a Task<(Of <(TResult>)>).

Namespace: System.Threading.Tasks
Assembly: System.Threading (in System.Threading.dll)

Syntax

Visual Basic (Declaration)
Public Function StartNew ( _ function As Func(Of Object, TResult), _ state As Object, _ cancellationToken As CancellationToken, _ creationOptions As TaskCreationOptions, _ scheduler As TaskScheduler _ ) As Task(Of TResult)

Visual Basic (Declaration)

Public Function StartNew ( _
	function As Func(Of Object, TResult), _
	state As Object, _
	cancellationToken As CancellationToken, _
	creationOptions As TaskCreationOptions, _
	scheduler As TaskScheduler _
) As Task(Of TResult)

C#
public Task<TResult> StartNew( Func<Object, TResult> function, Object state, CancellationToken cancellationToken, TaskCreationOptions creationOptions, TaskScheduler scheduler )

Parameters

function: Type: System..::.Func<(Of <(Object, TResult>)>)
A function delegate that returns the future result to be available through the Task<(Of <(TResult>)>).

state: Type: System..::.Object
An object containing data to be used by the function delegate.

cancellationToken: Type: System.Threading..::.CancellationToken
The CancellationToken that will be assigned to the new task.

creationOptions: Type: System.Threading.Tasks..::.TaskCreationOptions
A TaskCreationOptions value that controls the behavior of the created Task<(Of <(TResult>)>).

scheduler: Type: System.Threading.Tasks..::.TaskScheduler
The TaskScheduler that is used to schedule the created Task{TResult}.

Return Value

The started Task<(Of <(TResult>)>).

Remarks

Calling StartNew is functionally equivalent to creating a Task<(Of <(TResult>)>) using one of its constructors and then calling Start to schedule it for execution. However, unless creation and scheduling must be separated, StartNew is the recommended approach for both simplicity and performance.

Exceptions

Exception	Condition
System..::.ArgumentNullException	The exception that is thrown when the function argument is null.
System..::.ArgumentNullException	The exception that is thrown when the scheduler argument is null.
System..::.ArgumentOutOfRangeException	The exception that is thrown when the creationOptions argument specifies an invalid TaskCreationOptions value.
System..::.ObjectDisposedException	The provided CancellationToken has already been disposed.